Mobile Payments SDK Android Technical Reference/com.squareup.sdk.mobilepayments.payment/PaymentHandle

PaymentHandle

Representation of a payment process available immediately from PaymentManager.startPaymentActivity. Provides a way to interact with an ongoing payment, e.g. cancel it or select additionalPaymentMethods.

Types

CancelResult

enum CancelResult : Enum<PaymentHandle.CancelResult>

Return values from PaymentHandle.cancel.

Properties

additionalPaymentMethods

abstract val additionalPaymentMethods: List<AdditionalPaymentMethod>

Provides access to non-cardreader payment methods.

Functions

cancel

abstract fun cancel(): PaymentHandle.CancelResult

Cancels a pending payment, if one exists and can be canceled. In this case, the method returns CancelResult.CANCELED and the payment callbacks will be called with PaymentErrorCode.CANCELED to indicate the cancellation.

findMethod

abstract fun findMethod(type: AdditionalPaymentMethod.Type): AdditionalPaymentMethod?

Searches for a specific additional payment method by its type.